StringScanner.SkipOverSmatch Function

Syntax

Chars_Skipped as N = SkipOverSmatch as n(pattern as c)

Arguments

Chars_Skipped: The number of characters the offset has been moved.
pattern: The text to find in the buffer. You may use the "?" (single character) and "*" (any number of characters) expressions.

Description

Skip over a pattern . Returns number of characters skipped.

Discussion

The <StringScanner>.SkipOverSmatch() function moves the offset to the first position after the specified Find_Text and returns the number of characters that the offset has moved. The offset does not move if it is already pointing to the specified text.

Example

dim scanner as P
dim txt as C
txt = <<%text%
This is wonderful text
written by a great writer
%text%
scanner = stringscanner.create(txt)
? scanner.SkipOverSmatch("Th*w")
= 9
? scanner.GetToOffset()
= "This is w"
? scanner.getremainder()
= onderful text
written by a great writer